<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>v_sdirxss: xv_sdirxss_log.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">v_sdirxss
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xv__sdirxss__log_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xv_sdirxss_log.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><dl class="section note"><dt>Note</dt><dd>None.</dd></dl>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver   Who  Date     Changes
</p>
<hr/>
<p>
1.0   jsr  07/17/17 Initial release.
</pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a4deea5c587f6a732de2f6b127fc12b4d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xv__sdirxss__log_8c.html#a4deea5c587f6a732de2f6b127fc12b4d">XV_SdiRxSs_LogReset</a> (<a class="el" href="struct_x_v___sdi_rx_ss.html">XV_SdiRxSs</a> *InstancePtr)</td></tr>
<tr class="memdesc:a4deea5c587f6a732de2f6b127fc12b4d"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function will reset the driver's logging mechanism.  <a href="#a4deea5c587f6a732de2f6b127fc12b4d">More...</a><br/></td></tr>
<tr class="separator:a4deea5c587f6a732de2f6b127fc12b4d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4ec835467423d601222535543e1ffedf"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xv__sdirxss__log_8c.html#a4ec835467423d601222535543e1ffedf">XV_SdiRxSs_LogWrite</a> (<a class="el" href="struct_x_v___sdi_rx_ss.html">XV_SdiRxSs</a> *InstancePtr, <a class="el" href="xv__sdirxss_8h.html#ade9ffd7c4cd3343a53668c77788e00ba">XV_SdiRxSs_LogEvent</a> Evt, u8 Data)</td></tr>
<tr class="memdesc:a4ec835467423d601222535543e1ffedf"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function will insert an event in the driver's logginc mechanism.  <a href="#a4ec835467423d601222535543e1ffedf">More...</a><br/></td></tr>
<tr class="separator:a4ec835467423d601222535543e1ffedf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a79f6c8e124a9308ac14b02673b69d3bc"><td class="memItemLeft" align="right" valign="top">u16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xv__sdirxss__log_8c.html#a79f6c8e124a9308ac14b02673b69d3bc">XV_SdiRxSs_LogRead</a> (<a class="el" href="struct_x_v___sdi_rx_ss.html">XV_SdiRxSs</a> *InstancePtr)</td></tr>
<tr class="memdesc:a79f6c8e124a9308ac14b02673b69d3bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function will read the last event from the log.  <a href="#a79f6c8e124a9308ac14b02673b69d3bc">More...</a><br/></td></tr>
<tr class="separator:a79f6c8e124a9308ac14b02673b69d3bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3b2d7ef1aa9533cbc6661da353417cbc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xv__sdirxss__log_8c.html#a3b2d7ef1aa9533cbc6661da353417cbc">XV_SdiRxSs_LogDisplay</a> (<a class="el" href="struct_x_v___sdi_rx_ss.html">XV_SdiRxSs</a> *InstancePtr)</td></tr>
<tr class="memdesc:a3b2d7ef1aa9533cbc6661da353417cbc"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function will print the entire log.  <a href="#a3b2d7ef1aa9533cbc6661da353417cbc">More...</a><br/></td></tr>
<tr class="separator:a3b2d7ef1aa9533cbc6661da353417cbc"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a3b2d7ef1aa9533cbc6661da353417cbc"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XV_SdiRxSs_LogDisplay </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___sdi_rx_ss.html">XV_SdiRxSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function will print the entire log. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_v___sdi_rx_ss.html" title="The XV_SdiRxSs driver instance data. ">XV_SdiRxSs</a> core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="xv__sdirxss_8h.html#ade9ffd7c4cd3343a53668c77788e00baac87b23eb6dafee43b46fa934dbe65383">XV_SDIRXSS_LOG_EVT_NONE</a>, <a class="el" href="xv__sdirxss_8h.html#ade9ffd7c4cd3343a53668c77788e00baa6cbf56745454fffbcc6154ef9ac79225">XV_SDIRXSS_LOG_EVT_OVERFLOW</a>, <a class="el" href="xv__sdirxss_8h.html#ade9ffd7c4cd3343a53668c77788e00baa827f33ac2529c5f4cf3945835dcb1ce6">XV_SDIRXSS_LOG_EVT_RESET</a>, <a class="el" href="xv__sdirxss_8h.html#ade9ffd7c4cd3343a53668c77788e00baab255967dc5490db2cd7f57f778aec61e">XV_SDIRXSS_LOG_EVT_SDIRX_INIT</a>, <a class="el" href="xv__sdirxss_8h.html#ade9ffd7c4cd3343a53668c77788e00baa0080e57f6d625f1dd01a1c0e2f54bc8a">XV_SDIRXSS_LOG_EVT_SETSTREAM</a>, <a class="el" href="xv__sdirxss_8h.html#ade9ffd7c4cd3343a53668c77788e00baa97ea48bfa51c0ef66411f6ed68ab812c">XV_SDIRXSS_LOG_EVT_START</a>, <a class="el" href="xv__sdirxss_8h.html#ade9ffd7c4cd3343a53668c77788e00baa4da3f2426afca1983efd63a9214b6bfe">XV_SDIRXSS_LOG_EVT_STOP</a>, <a class="el" href="xv__sdirxss_8h.html#ade9ffd7c4cd3343a53668c77788e00baa1209a2edefec80b648ea7ce60d862ea9">XV_SDIRXSS_LOG_EVT_STREAMDOWN</a>, <a class="el" href="xv__sdirxss_8h.html#ade9ffd7c4cd3343a53668c77788e00baa3b50bef7159196dcf349504a79797a01">XV_SDIRXSS_LOG_EVT_STREAMSTART</a>, <a class="el" href="xv__sdirxss_8h.html#ade9ffd7c4cd3343a53668c77788e00baa9fcf3692334b29076b633a9eb7db3fbc">XV_SDIRXSS_LOG_EVT_STREAMUP</a>, <a class="el" href="xv__sdirxss_8h.html#ade9ffd7c4cd3343a53668c77788e00baa4dd4d4fa56c1ee97d5ace1b7c3543eb1">XV_SDIRXSS_LOG_EVT_UNDERFLOW</a>, and <a class="el" href="xv__sdirxss_8h.html#a79f6c8e124a9308ac14b02673b69d3bc">XV_SdiRxSs_LogRead()</a>.</p>

</div>
</div>
<a class="anchor" id="a79f6c8e124a9308ac14b02673b69d3bc"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u16 XV_SdiRxSs_LogRead </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___sdi_rx_ss.html">XV_SdiRxSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function will read the last event from the log. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_v___sdi_rx_ss.html" title="The XV_SdiRxSs driver instance data. ">XV_SdiRxSs</a> core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The log data.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_v___sdi_rx_ss___log.html#a23c2cddf5a657c4e288e0866596c70de">XV_SdiRxSs_Log::DataBuffer</a>, <a class="el" href="struct_x_v___sdi_rx_ss___log.html#abcbcd469377f7579be30243c760b3709">XV_SdiRxSs_Log::HeadIndex</a>, <a class="el" href="struct_x_v___sdi_rx_ss.html#aa8bead632dc99af35c9ab20fdd034741">XV_SdiRxSs::Log</a>, and <a class="el" href="struct_x_v___sdi_rx_ss___log.html#a993b179ac73b296c64a86ed0a9633c80">XV_SdiRxSs_Log::TailIndex</a>.</p>

<p>Referenced by <a class="el" href="xv__sdirxss__log_8c.html#a3b2d7ef1aa9533cbc6661da353417cbc">XV_SdiRxSs_LogDisplay()</a>.</p>

</div>
</div>
<a class="anchor" id="a4deea5c587f6a732de2f6b127fc12b4d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XV_SdiRxSs_LogReset </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___sdi_rx_ss.html">XV_SdiRxSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function will reset the driver's logging mechanism. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the xv_sdirxss core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_v___sdi_rx_ss___log.html#abcbcd469377f7579be30243c760b3709">XV_SdiRxSs_Log::HeadIndex</a>, <a class="el" href="struct_x_v___sdi_rx_ss.html#aa8bead632dc99af35c9ab20fdd034741">XV_SdiRxSs::Log</a>, and <a class="el" href="struct_x_v___sdi_rx_ss___log.html#a993b179ac73b296c64a86ed0a9633c80">XV_SdiRxSs_Log::TailIndex</a>.</p>

</div>
</div>
<a class="anchor" id="a4ec835467423d601222535543e1ffedf"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XV_SdiRxSs_LogWrite </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___sdi_rx_ss.html">XV_SdiRxSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="xv__sdirxss_8h.html#ade9ffd7c4cd3343a53668c77788e00ba">XV_SdiRxSs_LogEvent</a>&#160;</td>
          <td class="paramname"><em>Evt</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>Data</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function will insert an event in the driver's logginc mechanism. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_v___sdi_rx_ss.html" title="The XV_SdiRxSs driver instance data. ">XV_SdiRxSs</a> core instance. </td></tr>
    <tr><td class="paramname">Evt</td><td>is the event type to log. </td></tr>
    <tr><td class="paramname">Data</td><td>is the associated data for the event.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_v___sdi_rx_ss___log.html#a23c2cddf5a657c4e288e0866596c70de">XV_SdiRxSs_Log::DataBuffer</a>, <a class="el" href="struct_x_v___sdi_rx_ss___log.html#abcbcd469377f7579be30243c760b3709">XV_SdiRxSs_Log::HeadIndex</a>, <a class="el" href="struct_x_v___sdi_rx_ss.html#aa8bead632dc99af35c9ab20fdd034741">XV_SdiRxSs::Log</a>, <a class="el" href="struct_x_v___sdi_rx_ss___log.html#a993b179ac73b296c64a86ed0a9633c80">XV_SdiRxSs_Log::TailIndex</a>, and <a class="el" href="xv__sdirxss_8h.html#ade9ffd7c4cd3343a53668c77788e00baa51fc4231632e2b7294e582fe600c6ef9">XV_SDIRXSS_LOG_EVT_DUMMY</a>.</p>

<p>Referenced by <a class="el" href="xv__sdirxss_8h.html#a691319ac2baf302e4f0b833c0aafc963">XV_SdiRxSs_Start()</a>, <a class="el" href="xv__sdirxss_8h.html#ac4e45bc8ac7c85d1ad5958be34844543">XV_SdiRxSs_Stop()</a>, and <a class="el" href="group__v__sdirxss.html#ga8acb662b4cdd74817ee6b48f166f3e25">XV_SdiRxSs_SubcoreInitSdiRx()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
